Cancel Authorised Activities

Command:

Cancel the Authorised state.

The behaviour of this command depends upon the setting of the “Enable multiple authorised activities” switch of the console command Configure Security.

When multiple authorised activities are disabled, this command behaves as in previous releases of HSM8000 software – i.e. it cancels the ‘global’ Authorised State.

When multiple authorised activities are enabled, the Mode Flag parameter may be specified. If the Mode Flag is not present, then this command will cancel all authorised activities. If the Mode Flag is present, then this command behaves as follows:

00 – Cancel all authorised activities

01 – Cancel specified authorised activities

Notes:

When cancelling an Authorised Activity which includes a timeout, the original (i.e. not current) value of the timeout should be specified.

 

Field

Length & Type

Details

COMMAND MESSAGE

Message header

m A

(Subsequently returned to the Host unchanged).

Command code

2 A

Value RA.

Mode flag

2 H

Optional. If not present, all Authorised Activities are cancelled.

If present, the following values are valid:

00 – Cancel all Authorised Activities

01 – Cancel the following Authorised Activities

02 to FF – Reserved for future use  

Mode 00

No additional parameters are required

Mode 01

Number of Authorised Activities

3 N

Number of activities that follow

Authorised Activity 1

n A

ASCII encoding of an authorised activity to cancel, in the format of:

<category>[.<sub-category>][.<interface>][.<timeout>]

Delimiter 1

1 A

Value “;”

Authorised Activity 2

n A

ASCII encoding of an authorised activity to cancel, in the format of:

<category>[.<sub-category>][.<interface>][.<timeout>]

Delimiter 2

1 A

Value “;”

 

………………

….

…………………

  

Authorised Activity N

n A

ASCII encoding of an authorised activity to cancel, in the format of:

<category>[.<sub-category>][.<interface>][.<timeout>]

Delimiter N

1 A

Value “;”

End message delimiter

1 C

Optional. Must be present if a message trailer is present. Value X’19.

Message trailer

n A

Optional. Maximum length 32 characters.

RESPONSE MESSAGE

Message header

m A

Returned to the Host unchanged.

Response code

2 A

Value RB.

Error code

2 N

00 : No errors

01 : Invalid Mode Flag value

02 : Multiple Authorised Activities not enabled

03 : Specified activity not authorised

13 : LMK error; report to supervisor

15 : Error in input data

Mode 00

No fields are returned

Mode 01

Number of Authorised Activities

3 N

The number of authorised activities remaining after the completion of this command.

End message delimiter

1 C

Present only if present in the command message. Value X’19.

Message trailer

n A

Present only if present in the command message. Maximum length 32 characters.